// --------------------------------------------------------------------------------------------------------------------
// <copyright file="WSSEntityBase.cs" company="Collaboris Ltd.">
//   Copyright (c) Collaboris Ltd. All rights Reserved.
// </copyright>
// <summary>
//   Acts as the base entity for all SharePoint entities.
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace Collaboris.SharePoint.Wss.Entities
{
    using System;
    using System.Xml.Serialization;

    /// <summary>
    /// Acts as the base entity for all SharePoint entities.
    /// </summary>
    [Serializable]
    public class WSSEntityBase : EntityBase
    {
        /// <summary>
        /// the url of the site to process the file upon
        /// </summary>
        private string siteUrl;
        
        /// <summary>
        /// Gets or sets the site URL.
        /// </summary>
        /// <value>string containing the url to the site carry the action up.</value>
        /// <example>
        /// <para>
        /// /sportsout
        /// </para>
        /// <para>
        /// /sports/site1
        /// </para>
        /// </example>
        [XmlAttribute]
        public string SiteUrl
        {
            get
            {
                return this.siteUrl;
            }

            set
            {
                this.siteUrl = value;
            }
        }
    }
}